phosphor-boxpanel

phosphor-boxpanel

A Phosphor layout widget which arranges its children into a single row or column.

API Docs

Package Install

Prerequisites

• node

npm install --save phosphor-boxpanel

Source Build

Prerequisites

• git
• node

git clone https://github.com/phosphorjs/phosphor-boxpanel.git
cd phosphor-boxpanel
npm install

Rebuild

npm run clean
npm run build

Run Tests

Follow the source build instructions first.

# run tests in Firefox
npm test

# run tests in Chrome
npm run test:chrome

# run tests in IE
npm run test:ie

Build Docs

Follow the source build instructions first.

npm run docs

Navigate to docs/index.html.

Build Example

Follow the source build instructions first.

npm run build:example

Navigate to example/index.html.

Supported Runtimes

The runtime versions which are currently known to work are listed below. Earlier versions may also work, but come with no guarantees.

• IE 11+
• Firefox 32+
• Chrome 38+

Bundle for the Browser

Follow the package install instructions first.

npm install --save-dev browserify browserify-css
browserify myapp.js -o mybundle.js

Usage Examples

Note: This module is fully compatible with Node/Babel/ES6/ES5. Simply omit the type declarations when using a language other than TypeScript.

import { BoxPanel } from 'phosphor-boxpanel';

import { Widget } from 'phosphor-widget';


// Create some content for the panel.
var w1 = new Widget();
var w2 = new Widget();
var w3 = new Widget();

// Set the widget stretch factors (optional).
BoxPanel.setStretch(w1, 0);
BoxPanel.setStretch(w2, 2);
BoxPanel.setStretch(w3, 1);

// Set the widget size basis (optional).
BoxPanel.setSizeBasis(w1, 200);
BoxPanel.setSizeBasis(w2, 650);
BoxPanel.setSizeBasis(w3, 350);

// Setup the box panel.
var sp = new BoxPanel();
sp.direction = BoxPanel.LeftToRight;
sp.spacing = 5;
sp.children = [w1, w2, w3];